

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Diagram [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Automation Interface,Automation Interface Diagram, Diagram Package,Diagram,Diagram Automation Interface, Diagram Package,Diagram Package,Diagram Package Diagram, Automation Interface">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Diagram</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="diagram.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="diagramlinks.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_SubHeadingL1"><span class="f_SubHeadingL1">public Class</span></p>
<p class="p_BodyText"><span class="f_BodyText">A </span><span class="f_BodyText" style="font-style: italic;">Diagram</span><span class="f_BodyText"> corresponds to a single Enterprise Architect diagram. It is accessed through the </span><span class="f_BodyText" style="font-style: italic;">Package Diagrams</span><span class="f_BodyText"> collection and in turn contains a collection of diagram objects and diagram connectors. Adding to the </span><span class="f_BodyText" style="font-style: italic;">DiagramObjects</span><span class="f_BodyText"> collection adds an element to the diagram (the element must already exist). When adding a new diagram, you must set the diagram type to a valid type; these are:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Activity</span></li>
<li><span class="f_Bulletlist1">Analysis</span></li>
<li><span class="f_Bulletlist1">Component</span></li>
<li><span class="f_Bulletlist1">Custom</span></li>
<li><span class="f_Bulletlist1">Deployment</span></li>
<li><span class="f_Bulletlist1">Logical</span></li>
<li><span class="f_Bulletlist1">Sequence</span></li>
<li><span class="f_Bulletlist1">Statechart</span></li>
<li><span class="f_Bulletlist1">Use Case</span></li>
</ul>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Use the Analysis type for a Collaboration Diagram.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">Associated table in .EAP file: </span><span class="f_BodyText" style="font-style: italic;">t_diagram</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Diagram Attributes</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" bgcolor="#e3e6ed" style="width:156px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Attribute</span></p>
</td>
<td valign="top" width="83" bgcolor="#e3e6ed" style="width:83px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="542" bgcolor="#e3e6ed" style="width:542px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Notes</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Author</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The author.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">CreatedDate</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Date</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The date the diagram was created.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">cx</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The </span><span class="f_Tabletext" style="font-style: italic;">X</span><span class="f_Tabletext"> dimension of the diagram (default is 800).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">cy</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The </span><span class="f_Tabletext" style="font-style: italic;">Y</span><span class="f_Tabletext"> dimension of the diagram (default is 1100).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">DiagramGUID</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Variant</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. A globally unique ID for this diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">DiagramID</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. A local ID for the diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="link"></a><span class="f_Tabletext" style="font-weight: bold;">DiagramLinks</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. A list of </span><span class="f_Tabletext" style="font-style: italic;">DiagramLink</span><span class="f_Tabletext"> objects, each containing information about the display characteristics of a connector in a diagram.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">A DiagramLink is only created once a user modifies a connector in a diagram in some way. Until this condition has been met default values are used and the DiagramLink is not in use.</span></p>
</td>
</tr>
</table>
</div>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">DiagramObjects</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. A collection of references to </span><span class="f_Tabletext" style="font-style: italic;"><a href="diagramobjects.htm">DiagramObjects</a></span><span class="f_Tabletext">. A </span><span class="f_Tabletext" style="font-style: italic;">DiagramObject</span><span class="f_Tabletext"> is an instance of an element in a diagram, and includes size and display characteristics.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ExtendedStyle</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. An extended style attribute.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">HighlightImports</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to indicate elements from other packages should be highlighted.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">IsLocked</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag indicating whether this diagram is locked or not.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">MetaType</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only: The diagram's domain-specific meta type, as defined by an MDG Technology.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ModifiedDate</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Variant</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The date the diagram was last modified.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Name</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The diagram name.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Notes</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Set/retrieve notes for this diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ObjectType</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="objecttypeenum.htm">ObjectType</a></span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Distinguishes objects referenced through a </span><span class="f_Tabletext">Dispatch</span><span class="f_Tabletext"> interface.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Orientation</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Page orientation: </span><span class="f_Tabletext" style="font-weight: bold;">P</span><span class="f_Tabletext"> for Portrait or</span><span class="f_Tabletext" style="font-weight: bold;"> L</span><span class="f_Tabletext"> for Landscape.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">PackageID</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. An ID of the package that this diagram belongs to.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ParentID</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. An optional ID of an element that 'owns' this diagram; e.g. a Sequence diagram owned by a Use Case.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Scale</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The zoom scale (default is 100).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SelectedConnector</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="connector2_2.htm">Connector</a></span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The currently selected connector on this diagram. Null if there is no currently selected diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SelectedObjects</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Gets a collection representing the currently selected elements on the diagram. Can remove objects from this collection to deselect them, and add elements to the collection by passing the Object ID as a name to select them.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowDetails</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to indicate Diagram Details text should be shown. </span><span class="f_MenuKeyField">1</span><span class="f_Tabletext"> = Show, </span><span class="f_MenuKeyField">0</span><span class="f_Tabletext"> = Hide.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowPackageContents</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to indicate package contents should be shown in the current diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowPrivate</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to show or hide Private features.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowProtected</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to show or hide Protected features.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowPublic</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to show or hide Public features.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Stereotype</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Sets or gets the stereotype for this diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">StyleEx</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Advanced style settings. Reserved for the use of Sparx Systems.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Swimlanes</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Information on swimlanes contained in the diagram. Please note that this property is superseded by <a href="swimlanedef.htm">SwimlaneDef</a>.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">SwimlaneDef</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="swimlanedef.htm">SwimlaneDef</a></span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Information on swimlanes contained in the diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Type</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. The diagram type. See the </span><span class="f_Tabletext" style="font-style: italic;">t_diagramtypes</span><span class="f_Tabletext"> table in the .EAP file for more information.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Version</span></p>
</td>
<td valign="top" width="83" style="width:83px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="542" style="width:542px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The version of the diagram.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Diagram Methods</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" bgcolor="#e3e6ed" style="width:156px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Method</span></p>
</td>
<td valign="top" width="78" bgcolor="#e3e6ed" style="width:78px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="547" bgcolor="#e3e6ed" style="width:547px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Notes</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ApplyGroupLock (string aGroupName)</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Applies a group lock to this diagram object, for the specified group, on behalf of the current user.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError()</span><span class="f_Tabletext"> to retrieve error information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameter:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">aGroupName: String - the name of the user group for which to set the group lock.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ApplyUserLock ()</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Applies a user lock to this diagram object, for the current user.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError()</span><span class="f_Tabletext"> to retrieve error information.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetLastError ()</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Returns a string value describing the most recent error that occurred in relation to this object.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">This function is rarely used as an exception is thrown when an error occurs.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ReleaseLock ()</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Releases a group lock or user lock on this diagram object.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError()</span><span class="f_Tabletext"> to retrieve error information.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ReorderMessages ()</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Resets the display order of Sequence and Collaboration messages. Typically used after inserting or deleting messages in the diagram.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ShowAsElementList (</span><span class="f_Tabletext" style="font-weight: bold;">bool ShowAsList, bool Persist</span><span class="f_Tabletext" style="font-weight: bold;">)</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Toggles the diagram display between diagram format and </span><span class="f_UIControl">Element List</span><span class="f_Tabletext"> depending on the value of </span><span class="f_Tabletext" style="font-style: italic;">ShowAsList</span><span class="f_Tabletext">.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">If </span><span class="f_Tabletext" style="font-style: italic;">Persist</span><span class="f_Tabletext"> is set, the display format is written to the database so the diagram always opens in that format (diagram or list). Otherwise, the display format falls back to the default (diagram) once the display is closed.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="156" style="width:156px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Update ()</span></p>
</td>
<td valign="top" width="78" style="width:78px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="547" style="width:547px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Updates this diagram object after modification or appending a new item.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">If </span><span class="f_Tabletext" style="font-weight: bold;">false</span><span class="f_Tabletext"> is returned, use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError()</span><span class="f_Tabletext"> to retrieve error information.</span></p>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
